﻿/********************************************************************************
** 作者： Mick
** 邮箱： zheng_jinfan@126.com
** 主页： http://www.zhengjinfan.cn
** 创始时间：2016-2-17
** 描述：
**      [辅助类]XML操作辅助类
*********************************************************************************/
using System;
using System.Data;
using System.IO;
using System.Text;
using System.Web;
using System.Xml;
using System.Xml.Serialization;

namespace BestEasyCMS.Framework.Util
{
    /// <summary>
    /// [辅助类]XML操作辅助类
    /// </summary>
    public class XmlUtil
    {

        #region 字段定义
        /// <summary>
        /// XML文件的物理路径
        /// </summary>
        private static string _filePath = string.Empty;
        /// <summary>
        /// Xml文档
        /// </summary>
        private static XmlDocument _xml;
        /// <summary>
        /// XML的根节点
        /// </summary>
        private static XmlElement _element;
        #endregion

        #region 构造方法

        /// <summary>
        /// 实例化XmlHelper对象
        /// </summary>
        /// <param name="xmlFilePath">Xml文件的相对路径</param>
        public XmlUtil(string xmlFilePath)
        {
            //获取XML文件的绝对路径
            _filePath = GetMapPath(xmlFilePath);
        }
        #endregion

        #region 创建XML的根节点
        /// <summary>
        /// 创建XML的根节点
        /// </summary>
        private static void CreateXmlElement()
        {

            //创建一个XML对象
            _xml = new XmlDocument();

            if (DirFileUtil.IsExistFile(_filePath))
            {
                //加载XML文件
                _xml.Load(_filePath);
            }

            //为XML的根节点赋值
            _element = _xml.DocumentElement;
        }
        #endregion

        #region 获取指定XPath表达式的节点对象
        /// <summary>
        /// 获取指定XPath表达式的节点对象
        /// </summary>        
        /// <param name="xPath">XPath表达式,
        /// 范例1: @"Skill/First/SkillItem", 等效于 @"//Skill/First/SkillItem"
        /// 范例2: @"Table[USERNAME='a']" , []表示筛选,USERNAME是Table下的一个子节点.
        /// 范例3: @"ApplyPost/Item[@itemName='岗位编号']",@itemName是Item节点的属性.
        /// </param>
        public static XmlNode GetNode(string xPath)
        {
            //创建XML的根节点
            CreateXmlElement();

            //返回XPath节点
            return _element.SelectSingleNode(xPath);
        }
        #endregion

        #region 获取指定XPath表达式节点的值
        /// <summary>
        /// 获取指定XPath表达式节点的值
        /// </summary>
        /// <param name="xPath">XPath表达式,
        /// 范例1: @"Skill/First/SkillItem", 等效于 @"//Skill/First/SkillItem"
        /// 范例2: @"Table[USERNAME='a']" , []表示筛选,USERNAME是Table下的一个子节点.
        /// 范例3: @"ApplyPost/Item[@itemName='岗位编号']",@itemName是Item节点的属性.
        /// </param>
        public static string GetValue(string xPath)
        {
            //创建XML的根节点
            CreateXmlElement();

            //返回XPath节点的值
            var selectSingleNode = _element.SelectSingleNode(xPath);
            return selectSingleNode != null ? selectSingleNode.InnerText : "";
        }

        #endregion

        #region 获取指定XPath表达式节点的属性值
        /// <summary>
        /// 获取指定XPath表达式节点的属性值
        /// </summary>
        /// <param name="xPath">XPath表达式,
        /// 范例1: @"Skill/First/SkillItem", 等效于 @"//Skill/First/SkillItem"
        /// 范例2: @"Table[USERNAME='a']" , []表示筛选,USERNAME是Table下的一个子节点.
        /// 范例3: @"ApplyPost/Item[@itemName='岗位编号']",@itemName是Item节点的属性.
        /// </param>
        /// <param name="attributeName">属性名</param>
        public static string GetAttributeValue(string xPath, string attributeName)
        {
            //创建XML的根节点
            CreateXmlElement();

            //返回XPath节点的属性值
            var selectSingleNode = _element.SelectSingleNode(xPath);
            if (selectSingleNode == null) return string.Empty;
            return selectSingleNode.Attributes != null ? selectSingleNode.Attributes[attributeName].Value : string.Empty;
        }

        #endregion

        #region 新增节点
        /// <summary>
        /// 1. 功能：新增节点。
        /// 2. 使用条件：将任意节点插入到当前Xml文件中。
        /// </summary>        
        /// <param name="xmlNode">要插入的Xml节点</param>
        public static void AppendNode(XmlNode xmlNode)
        {
            //创建XML的根节点
            CreateXmlElement();

            //导入节点
            var node = _xml.ImportNode(xmlNode, true);

            //将节点插入到根节点下
            _element.AppendChild(node);
        }

        /// <summary>
        /// 1. 功能：新增节点。
        /// 2. 使用条件：将DataSet中的第一条记录插入Xml文件中。
        /// </summary>        
        /// <param name="ds">DataSet的实例，该DataSet中应该只有一条记录</param>
        public static void AppendNode(DataSet ds)
        {
            //创建XmlDataDocument对象
#pragma warning disable 618
            var xmlDataDocument = new XmlDataDocument(ds);
#pragma warning restore 618

            //导入节点
            if (xmlDataDocument.DocumentElement != null)
            {
                var node = xmlDataDocument.DocumentElement.FirstChild;

                //将节点插入到根节点下
                AppendNode(node);
            }
        }
        #endregion

        #region 删除节点
        /// <summary>
        /// 删除指定XPath表达式的节点
        /// </summary>        
        /// <param name="xPath">XPath表达式,
        /// 范例1: @"Skill/First/SkillItem", 等效于 @"//Skill/First/SkillItem"
        /// 范例2: @"Table[USERNAME='a']" , []表示筛选,USERNAME是Table下的一个子节点.
        /// 范例3: @"ApplyPost/Item[@itemName='岗位编号']",@itemName是Item节点的属性.
        /// </param>
        public static void RemoveNode(string xPath)
        {
            //创建XML的根节点
            CreateXmlElement();

            //获取要删除的节点
            var node = _xml.SelectSingleNode(xPath);

            //删除节点
            if (node != null) _element.RemoveChild(node);
        }
        #endregion //删除节点

        #region 保存XML文件
        /// <summary>
        /// 保存XML文件
        /// </summary>        
        public static void Save()
        {
            //创建XML的根节点
            CreateXmlElement();

            //保存XML文件
            _xml.Save(_filePath);
        }
        #endregion //保存XML文件

        #region 静态方法

        #region 创建根节点对象
        /// <summary>
        /// 创建根节点对象
        /// </summary>
        /// <param name="xmlFilePath">Xml文件的相对路径</param>        
        private static XmlElement CreateRootElement(string xmlFilePath)
        {
            //定义变量，表示XML文件的绝对路径

            //获取XML文件的绝对路径
            var filePath = GetMapPath(xmlFilePath);

            //创建XmlDocument对象
            var xmlDocument = new XmlDocument();
            //加载XML文件
            xmlDocument.Load(filePath);

            //返回根节点
            return xmlDocument.DocumentElement;
        }
        #endregion

        #region 获取指定XPath表达式节点的值
        /// <summary>
        /// 获取指定XPath表达式节点的值
        /// </summary>
        /// <param name="xmlFilePath">Xml文件的相对路径</param>
        /// <param name="xPath">XPath表达式,
        /// 范例1: @"Skill/First/SkillItem", 等效于 @"//Skill/First/SkillItem"
        /// 范例2: @"Table[USERNAME='a']" , []表示筛选,USERNAME是Table下的一个子节点.
        /// 范例3: @"ApplyPost/Item[@itemName='岗位编号']",@itemName是Item节点的属性.
        /// </param>
        public static string GetValue(string xmlFilePath, string xPath)
        {
            //创建根对象
            var rootElement = CreateRootElement(xmlFilePath);

            //返回XPath节点的值
            var selectSingleNode = rootElement.SelectSingleNode(xPath);
            return selectSingleNode != null ? selectSingleNode.InnerText : string.Empty;
        }

        #endregion

        #region 获取指定XPath表达式节点的属性值
        /// <summary>
        /// 获取指定XPath表达式节点的属性值
        /// </summary>
        /// <param name="xmlFilePath">Xml文件的相对路径</param>
        /// <param name="xPath">XPath表达式,
        /// 范例1: @"Skill/First/SkillItem", 等效于 @"//Skill/First/SkillItem"
        /// 范例2: @"Table[USERNAME='a']" , []表示筛选,USERNAME是Table下的一个子节点.
        /// 范例3: @"ApplyPost/Item[@itemName='岗位编号']",@itemName是Item节点的属性.
        /// </param>
        /// <param name="attributeName">属性名</param>
        public static string GetAttributeValue(string xmlFilePath, string xPath, string attributeName)
        {
            //创建根对象
            var rootElement = CreateRootElement(xmlFilePath);

            //返回XPath节点的属性值
            var selectSingleNode = rootElement.SelectSingleNode(xPath);
            if (selectSingleNode == null) return string.Empty;
            return selectSingleNode.Attributes != null ? selectSingleNode.Attributes[attributeName].Value : string.Empty;
        }

        #endregion

        #endregion


        /// <summary>
        /// 序列化
        /// </summary>
        /// <param name="xmlPath">Xml文件路径</param>
        /// <param name="type">对象的类型</param>
        /// <param name="model">对象</param>
        public static void SerializerObject(string xmlPath, Type type, object model)
        {
            xmlPath = GetMapPath(xmlPath);
            //创建序列化
            var serial = new XmlSerializer(type);

            //创建文件
            using (TextWriter xWriter = new StreamWriter(xmlPath, false, Encoding.UTF8))
            {
                serial.Serialize(xWriter, model);
            }
        }

        /// <summary>
        /// 反序列化
        /// </summary>
        /// <param name="xmlPath">Xml文件路径</param>
        /// <param name="type">对象的类型</param>
        /// <returns></returns>
        public static object DeserializeObject(string xmlPath, Type type)
        {
            xmlPath = GetMapPath(xmlPath);

            var serial = new XmlSerializer(type);
            object model;
            using (var reader = new StreamReader(xmlPath, Encoding.UTF8))
            {
                model = serial.Deserialize(reader);
            }
            return model;
        }

        /// <summary>
        /// 获取物理路径
        /// </summary>
        /// <param name="path">虚拟路径或物理路径</param>
        /// <returns></returns>
        public static string GetMapPath(string path)
        {
            if (!File.Exists(path))
                path = HttpContext.Current.Server.MapPath(path);

            return path;
        }


    }
}